/**
 * Copyright (c) 2010 by Kevin Bierhoff.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. Neither the names of the authors nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.syper.test.javasyp.perm;

import com.googlecode.syper.anno.Excl;
import com.googlecode.syper.anno.ReturnExcl;

import edu.cmu.cs.crystal.annotations.FailingTest;
import edu.cmu.cs.crystal.annotations.UseAnalyses;

/**
 * Failing tests for borrowing "from" method or constructor.
 * <p>
 * @author kevin
 * @since Mar 21, 2010
 */
@FailingTest(8)
@UseAnalyses("SymbolicChecker")
public class BorrowFromFail {

	@Excl private Object captured;

	public BorrowFromFail(@Excl(released = true) Object arg) {
		captured = arg;
		// ok
	}
	
	@ReturnExcl
	@Excl(released = true)
	public Object getCaptured() {
		capture(this);
		return new Object(); // fails: receiver cannot be released
	}
	
	/** helper for making {@link #getCaptured()} fail */
	private static void capture(@Excl(borrowed = false) Object o) {}

	@ReturnExcl
	@Excl(released = false)
	public Object getCaptured2() {
		// fails b/c receiver is consumed when consuming the field
		excl: return captured;
	}
	
	@ReturnExcl
	public static BorrowFromFail testConstructor() {
		@Excl(borrowed = false) BorrowFromFail b = new BorrowFromFail(new Object());
		@Excl Object o = b.getCaptured();
		o.toString();
		return b; // fails: b is not borrowed
		// could pass: b's field is not needed again
	}

	@ReturnExcl
	public static BorrowFromFail testConstructor(@Excl Object o) {
		@Excl(borrowed = false) BorrowFromFail b = new BorrowFromFail(o);
		@Excl Object o2 = b.getCaptured();
		o2.toString();
		return b; // fails: b is not borrowed
	}

	@ReturnExcl
	public static Object testGetter(@Excl BorrowFromFail b) {
		@Excl(borrowed = false) Object o = b.getCaptured();
		return o; // fails: o is not borrowed
	}

}
